home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / applications / wp / textra16.lha / Textra116 / Docs / TextraScripts.doc < prev    next >
Encoding:
Text File  |  1995-01-04  |  11.1 KB  |  247 lines
  1.  
  2. This is a list of all the scripts that come with Textra 1.16,
  3. accompanied by a short description and an example of their use.
  4.  
  5. All scriptnames (minus the '.textra'), with or without arguments, 
  6. may be enetered in any of the 10 saveable string gadgets in the 
  7. ARexx requester.  8 of these are bound to a function key.
  8.  
  9. Textra will bind scripts named CTRLA.textra, CTRLB.textra, etc.
  10. to the appropriate CTRL-key combination.  Case-insensitive, up
  11. to 26 CTRL key combinations may be defined for chars A thru Z.
  12. of course, such scripts do not accept arguments in the normal
  13. sense, but can look at environment variables, files, etc.
  14.  
  15. A complete glossary of the 70+ available commands that make
  16. up the Textra-ARexx interface is included in the Textra package,
  17. (in the RexxCommand.doc file) as well as full documentation
  18. for all editor features (in the Textra.doc file).
  19.  
  20.  
  21. General Textra ARexx scripts
  22. ===========================================================================
  23. AddIcon.textra - With just a little setup work, this script can be
  24.                  used to create Workbench icons for your Textra files.
  25.                  Double-clicking on them opens the text file in Textra!
  26.  
  27. Art1.textra & Art2.textra - neat random-movement ascii
  28.               graphics... hard to believe it's a text editor!  Thanks to
  29.               Nick Didkovsky (saying thanks to Nick gets to be a habit!),
  30.               long-time JForth guru.
  31.  
  32. bol.textra - Moves the cursor to the beginning of the current line
  33.              (In Textra 1.15 and higher, 'column 0' is faster)
  34.              Usage:  bol
  35.              
  36. date.textra - Writes the current date at the cursor/select location
  37.               Usage:  date
  38.  
  39. DelToEnd.textra - Deletes from the current cursor/select to the
  40.                   end of the line (sounds ominous, eh?)
  41.                   Usage:  deltoend
  42.  
  43. DelToStart.textra - Deletes from the current cursor/select to the
  44.                     beginning of the line.
  45.                     Usage:  deltostart
  46.                     
  47. DelWholeLine.textra - Deletes the entire cursor/select line
  48.                       Usage:  delwholeline
  49.  
  50. DoubleSpace.textra - Adds a blank line between every line in the
  51.                      selected range
  52.                      Usage:  Doublespace
  53.  
  54. eol.textra - Moves the cursor to the end of the current line
  55.              (In Textra 1.15 and higher, 'column "-1"' is faster)
  56.              Usage:  eol
  57.              
  58. eval.textra - Select a mathematical expression, eval will calculate
  59.               it and display the answer, and even optionally insert
  60.               the answer in the text document at the current
  61.               cursor/select position!
  62.               Usage:  eval             (displays answer in requester)
  63.                       eval <anystring> (inserts answer in document)
  64.               
  65. Files.textra - Opens a window and presents a very informative
  66.                display of summary information for each open
  67.                Textra window (#lines, size in ram & on disk,
  68.                'changed' status, window position, more)
  69.                Usage:  files
  70.                
  71. Hello.textra - Simple example of text insertion and delay timing.
  72.                Usage:  hello
  73.                
  74. indent.textra - Similar to slide.textra, this script will also shift
  75.                 selected lines of text left or right, but uses TABs
  76.                 for the whitespace character (slide.textra uses
  77.                 BLANKs)  See scoot.textra and slide.textra.
  78.                 Usage:  indent 2       (shifts 2 TAB chars right)
  79.                         indent -2      (shifts 2 TAB chars left)
  80.                 
  81. InsertF.textra - recommend you assign this to a CTRL or F-
  82.                  key.  Then, enter & select the filename, then at the
  83.                  touch of that key, the file is inserted.
  84.    
  85. MarkAutodoc.textra - Open any standard Commodore autodoc file and
  86.                      let this script fly!  When done, there will
  87.                      be a defined MARK for every function described,
  88.                      allowing you to save the MARKS info permanently
  89.                      without changing the original autodoc file at all!
  90.                      Your autodoc-navigating problems are over.
  91.                      (without AmigaGuide and it's overhead)
  92.                      Usage:  MarkAutoDoc
  93.                      
  94. paragraph.textra - Used for paragraph formatting, works on the selected
  95.                    lines, accepts 3 arguments:
  96.                    1. left margin of first line
  97.                    2. left margin of all following lines in selection
  98.                    3. right margin for all lines.
  99.                    Multiple paragraphs may be formatted, just put a
  100.                    blank line between each intended paragraph.
  101.                    Usage:  paragraph 12 8 68
  102.                    
  103. Scary.textra - Simple example of conditional branching and prompting
  104.                the user with a YES/NO question and waiting for the
  105.                answer. 
  106.                Usage:  scary
  107.                
  108. Scoot.textra - A very versatile script that really replaces both
  109.                slide.textra and indent.textra.  This one also shifts
  110.                blocks of text left and right, and can be told to use
  111.                EITHER TABs or BLANKs for whitespace!  It can also be
  112.                used to convert between the two (entab & reverse entab)
  113.                with no visible change.  The only disadvantage is that
  114.                it is slightly slower than either of it's subsets (so
  115.                they remain in the package).
  116.                Usage:  scoot 0    (entabs)
  117.                        scoot 12
  118.                        scoot -2
  119.                
  120. ScootTest.textra - Can be used with scoot.textra for making sure a
  121.                    left-shift argument will not lose any characters by
  122.                    inadvertantly being too large.
  123.                    Usage:  scoot -2
  124.                    
  125. SingleSpace.textra - Removes all blank lines in the select range.
  126.                      Usage:  SingleSpace
  127.  
  128. Slide.textra - Similar to indent.textra, this script will also shift
  129.                selected lines of text left or right, but uses BLANKs
  130.                for the whitespace character (indent.textra uses
  131.                TABs)  Also see scoot.textra.
  132.                Usage:  slide 14
  133.                        slide -4
  134.                
  135. StartTextra.rexx - Not intended for use from textra, this script
  136.                    can be used by other applications as a convienient
  137.                    way to open Textra on a given file.
  138.                    Usage:  rx 'starttextra <filename>'
  139.                    
  140. TInfo.textra - Illustrates use of the Textra PREFS Arexx command, as well
  141.                as illustrating Textra's excellent error recovery when
  142.                an illegal argument is passed.
  143.                usage:  TInfo
  144.                
  145. Tutorial.textra - Self explanatory.
  146.                   Usage:  Tutorial
  147.  
  148. WhereAmI.textra - Sample of reading/interpreting cursor or select position.
  149.                   Usage:  WhereAmI
  150.  
  151.  
  152. General C Language scripts
  153. ===========================================================================
  154. Box.textra - Select some lines and enter Box, all will be commented out
  155.              with an orderly box of '*' chars.
  156.              Usage:  box
  157.              
  158. MarkCFuncs.textra - Creates a defined MARK for all the functions in your
  159.                     C source file.
  160.                     Usage:  markcfuncs
  161.                     
  162. UnBox.textra - Removes the comment "box" created by box.textra.
  163.                Usage:  unbox
  164.  
  165.  
  166. Scripts to integrate with SAS/C
  167. ===========================================================================
  168. CTRLB.textra - Press CTRL-B to 'B'uild current project.  This is the easy 
  169.                way to restart the compiler after you have made changes to 
  170.                the source... even checks for the existence of a make file!
  171.                Usage:  ctrlb        (automatically bound to CTRL-B key)
  172.                
  173. CTRLF.textra - Press CTRL-F to 'F'ind current symbol.  Similar to the 
  174.                script provided with SE, this will allow you to place the 
  175.                cursor on a C symbol (such as 'strlen', et. al.), and GSTs 
  176.                will be searched for that symbol, with a new window popping 
  177.                up with the file that symbol is defined in if found.
  178.                Usage:  ctrlf        (automatically bound to CTRL-F key)
  179.  
  180. CTRLN.textra - Press CTRL-N to step to the 'N'ext compiler error/warning.
  181.                Usage:  ctrln        (automatically bound to CTRL-N key)
  182.  
  183. CTRLP.textra - Press CTRL-P to step to the 'P'revious compiler error/warning.
  184.                Usage:  ctrlp        (automatically bound to CTRL-P key)
  185.  
  186. SCMSG - Sample SAS/C compiler config file to tell SAS/C to use Textra.
  187.         Usage:  See SASC.readme in Textra package.
  188.  
  189.  
  190. Scripts to integrate with HS/Pascal
  191. ===========================================================================
  192. HScompile.textra - Invokes HS/Pascal to compile the selected file.
  193.                    Usage:  hscompile
  194.  
  195.  
  196. Scripts to integrate with JForth Professional
  197. ===========================================================================
  198. DeferStub.textra - This simple AREXX script is useful for assigning stub 
  199.                    words to deferred words in JForth source code.
  200.                    Usage:  DeferStub   (on selected text)
  201.  
  202. interpret.textra - Send the selected text to the JForth interpreter.
  203.                    Usage:  interpret
  204.  
  205. JCompile.textra - Tell JForth to compile the selected file.
  206.                   Usage:  JCompile
  207.  
  208. jfcomment.textra - Comment out the selected lines, or uncomment them if
  209.                    already commented out.
  210.                    Usage:  jfcomment
  211.                            jfcomment <comment char>
  212.  
  213. jFILE?.textra - Accepts the name of a JForth function, passes it to the
  214.                 JForth FILE? function.
  215.                 Usage:  jfile? <function name>
  216.  
  217. MarkColons.textra - Finds and MARKS all high-level definitions in a
  218.                     JForth source file (colon definitions)
  219.                     Usage:  markcolons
  220.  
  221. nextcolon.textra - Locates the next colon definition in the file, following
  222.                    the current cursor/select position.
  223.                    Usage:  nextcolon
  224.  
  225. Textra.f - JForth source file which must be compiled into your JForth
  226.            before you can use the view.textra or viewsel.textra scripts.
  227.            Usage:  compiled into JForth
  228.  
  229. tojf.textra - accepts a string and passes it to the JForth interpreter.
  230.               Usage:  tojf <the string>
  231.  
  232. view.textra - accepts the name of a JForth function name and opens the
  233.               souce file and locates the definition.  (JForth must
  234.               be running and listening to ARExx.  Also, see Textra.f).
  235.               Usage:  view <function name>
  236.  
  237. viewsel.textra - Considers the selected text to be a JForth function name 
  238.                  and opens the souce file and locates the definition.  
  239.                  (JForth must be running and listening to ARExx.  Also, see 
  240.                  Textra.f).
  241.                  Usage:  viewsel
  242.  
  243. zDotIf.textra - used to conditionally comment in-or-out the selected lines
  244.                 of source code by inserting/deleting pairs of "0 .IF" and
  245.                 ".THEN" statements.
  246.                 Usage:  zDotIf
  247.